home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / amiga / gui / mui / mui14-dv.lha / MUI / Developer / Autodocs / MUImaster.doc < prev   
Encoding:
Text File  |  1993-10-28  |  6.5 KB  |  227 lines
  1. TABLE OF CONTENTS
  2.  
  3. muimaster.library/--background--
  4. muimaster.library/MUI_NewObjectA
  5. muimaster.library/MUI_DisposeObject
  6. muimaster.library/MUI_RequestA
  7. muimaster.library/MUI_AllocAslRequest
  8. muimaster.library/MUI_AslRequest
  9. muimaster.library/MUI_FreeAslRequest
  10. muimaster.library/MUI_Error
  11. muimaster.library/--background-- 
  12.  
  13.    PURPOSE
  14.     MUI is based on boopsi, the Basic Object Oriented Programming
  15.     System For Intuition, so why do we need an extra muimaster.library?
  16.  
  17.     Well, for easiness of GUI creation, MUI depends on auto class
  18.     loading. When you try to create an instance of a MUI class and
  19.     the class is not yet in memory, it will automatically be
  20.     loaded from disk. Standard NewObject() calls don't support this
  21.     feature, MUI_NewObject() calls do.
  22.  
  23.     Additionally, muimaster.library contains a function similiar
  24.     to EasyRequest() to be used in MUI applications, some error handling
  25.     support functions and lots of private calls for use of all
  26.     MUI classes.
  27.  
  28. muimaster.library/MUI_NewObjectA             
  29.  
  30.    NAME
  31.     MUI_NewObjectA -- Create an object from a class.
  32.     MUI_NewObject -- Varargs stub for MUI_NewObjectA().
  33.  
  34.    SYNOPSIS
  35.     object = MUI_NewObjectA( class, tags )
  36.     D0                      A0     A1
  37.  
  38.     APTRáMUI_NewObjectA( char *, struct TagItem * );
  39.  
  40.     object = MUI_NewObject( classID, Tag1, ... )
  41.  
  42.     APTR MUI_NewObject( classID, ULONG, ... );
  43.  
  44. á  FUNCTION
  45.     This is the general method of creating objects from MUI classes.
  46.     You specify a class by its ID string. If the class is not
  47.     already in memory, it will be loaded using OpenLibrary("mui/%s",0)
  48.  
  49.     You further specify initial "create-time" attributes for the
  50.     object via a TagItem list, and they are applied to the resulting
  51.     generic data object that is returned. The attributes, their meanings,
  52.     attributes applied only at create-time, and required attributes
  53.     are all defined and documented on a class-by-class basis.
  54.  
  55.    INPUTS
  56.     classID = the name/ID string of a MUI class, e.g. "Image.mui".
  57.               Class names are case sensitive!
  58.  
  59.     tagList = pointer to array of TagItems containing attribute/value
  60.               pairs to be applied to the object being created.
  61.  
  62.    RESULT
  63.     A MUI object, which may be used in different contexts such
  64.     as an application, window or gadget, and may be manipulated
  65.     by generic functions. You eventually free the object using
  66.     MUI_DisposeObject().
  67.     NULL indicates failure, more information on the error can be
  68.     obtained with MUI_Error().
  69.  
  70.    BUGS
  71.  
  72.    SEE ALSO
  73.     MUI_DisposeObject(), MUI_Error(), SetAttrs(), GetAttr().
  74.  
  75. muimaster.library/MUI_DisposeObject
  76.  
  77.    NAME
  78.     MUI_DisposeObject -- Delete a MUI object.
  79.  
  80.    SYNOPSIS
  81.     MUI_DisposeObject( object )
  82.                        A0
  83.  
  84.     VOIDáMUI_DisposeObject( APTR );
  85.  
  86. á  FUNCTION
  87.     Deletes a MUI object and all of it's auxiliary data.
  88.     These objects are all created by MUI_NewObject(). Objects
  89.     of certain classes "own" other objects, which will also
  90.     be deleted when the object is passed to MUI_DisposeObject().
  91.     Read the per-class documentation carefully to be aware
  92.     of these instances.
  93.  
  94.    INPUTS
  95.     object = abstract pointer to a MUI object returned by
  96.              MUI_NewObject(). The pointer may be NULL, in which case
  97.              this function has no effect.
  98.  
  99.    RESULT
  100.     None.
  101.  
  102.    BUGS
  103.  
  104.    SEE ALSO
  105.     MUI_NewObject(), SetAttrs(), GetAttr().
  106.  
  107. muimaster.library/MUI_RequestA
  108.  
  109.    NAME
  110.     MUI_RequestA  -- Pop up a MUI requester.
  111.  
  112.    SYNOPSIS
  113.     MUI_RequestA(app,win,flags,title,gadgets,format,params)
  114.                  D0   D1  D2    A0     A1      A2     A3
  115.  
  116.     LONG MUI_RequestA ( APTR app, APTR win, LONGBITS flags,
  117.          char *title, char *gadgets, char *format, APTR params );
  118.  
  119.     LONG MUI_Request ( APTR app, APTR win, LONGBITS flags,
  120.          char *title, char *gadgets, char *format, ...);
  121.  
  122. á  FUNCTION
  123.     Pop up a MUI requester. Using a MUI requester instead
  124.     of a standard system requester offers you the possibility
  125.     to include text containing all the text engine format codes.
  126.  
  127.    INPUTS
  128.     app     - The application object. If you leave this
  129.               NULL, MUI_RequestA() will fall back to a
  130.               standard system requester.
  131.  
  132.     win     - Pointer to a window of the application. If
  133.               this is used, the requester will appear centered
  134.               relative to this window.
  135.  
  136.     flags   - For future expansion, must be 0.
  137.  
  138.     title   - Title for the requester window. Defaults to the
  139.               name of the application when NULL (and app!=NULL).
  140.  
  141.     gadgets - Pointer to a string containing the possible answers.
  142.               The format looks like "Save|Use|Test|Cancel".
  143.               If you precede an entry with a '*', this answer will
  144.               become the active object. Pressing <Return> will
  145.               terminate the requester with this response.
  146.  
  147.     format  - A printf-style formatting string.
  148.  
  149.     params  - Pointer to an array of ULONG containing the parameter
  150.               values for format.
  151.  
  152.    RESULT
  153.     0, 1, ..., N = Successive id values, for the gadgets
  154.     you specify for the requester.  NOTE: The numbering
  155.     from left to right is actually: 1, 2, ..., N, 0.
  156.  
  157.    SEE ALSO
  158.     MUIA_Text_Contents
  159.  
  160. muimaster.library/MUI_AllocAslRequest
  161.  
  162.    NAME
  163.     MUI_AllocAslRequest
  164.  
  165.    FUNCTION
  166.     Provide an interface to asl.library. Using this ensures
  167.     your application will benefit from future expansions
  168.         to MUI's window and iconification handling.
  169.  
  170.    SEE ALSO
  171.     asl.library/AllocAslRequest
  172.  
  173. muimaster.library/MUI_AslRequest
  174.  
  175.    NAME
  176.     MUI_AslRequest
  177.  
  178.    FUNCTION
  179.     Provide an interface to asl.library. Using this ensures
  180.     your application will benefit from future expansions
  181.         to MUI's window and iconification handling.
  182.  
  183.    SEE ALSO
  184.     asl.library/AslRequest
  185.  
  186. muimaster.library/MUI_FreeAslRequest
  187.  
  188.    NAME
  189.     MUI_FreeAslRequest
  190.  
  191.    FUNCTION
  192.     Provide an interface to asl.library. Using this ensures
  193.     your application will benefit from future expansions
  194.         to MUI's window and iconification handling.
  195.  
  196.    SEE ALSO
  197.     asl.library/FreeAslRequest
  198.  
  199.  
  200.  
  201. muimaster.library/MUI_Error                       muimaster.library/MUI_Error
  202.  
  203.    NAME
  204.     MUI_Error -- Return extra information from the MUI system.
  205.  
  206.    SYNOPSIS
  207.     LONG MUI_Error(VOID);
  208.  
  209. á  FUNCTION
  210.     Some MUI functions will set an error if they fail for
  211.     some reason. The error functions is task sensitive,
  212.     only the task that caused the error will receive it.
  213.  
  214.    RESULT
  215.     Currently, the following error values are defined:
  216.  
  217.     MUIE_OK                  - no error, everything allright.
  218.     MUIE_OutOfMemory         - went out of memory.
  219.     MUIE_OutOfGfxMemory      - went out of graphics memory.
  220.     MUIE_InvalidWindowObject - NULL window specified.
  221.     MUIE_MissingLibrary      - can't open a needed library.
  222.     MUIE_NoARexx             - unable to create arexx port.
  223.     MUIE_SingleTask          - application is already running.
  224.  
  225.    SEE ALSO
  226.  
  227.